🦊カスタムノードをComfy Registryに登録する
🏠 | 🦊雑に学ぶComfyUI
👈 |
👉 |
Comfy Registryは、ComfyUIのカスタムノードを安全・統一的に配布するための公式レジストリです
以前はComfyUI Managerが自動でGitHubをクロールしていましたが、現在は開発者自身が登録する仕組みに変わりました
登録は少し手間ですが、セキュリティ検査・バージョン管理・依存関係の明確化が行われますし、 なによりgit cloneなどせずにComfyUI managerから簡単にノードをインストールできるようになるので頑張りましょう
目次
🦊カスタムノードをComfy Registryに登録する#68f2738d000000000039a4b71. Publisher登録
🦊カスタムノードをComfy Registryに登録する#68f2752e000000000039a4b92. APIキーの取得
🦊カスタムノードをComfy Registryに登録する#68f27942000000000039a4c43. Comfy CLIのインストール
🦊カスタムノードをComfy Registryに登録する#68f27a28000000000039a4c94. プロジェクトの初期化
🦊カスタムノードをComfy Registryに登録する#68f27da0000000000039a4d95. Comfy Registryに公開 (Comfy CLI)
🦊カスタムノードをComfy Registryに登録する#68f2821a000000000039a4e86. Comfy Registryに公開 (GitHub Actions)
参考
https://docs.comfy.org/registry/publishingPublishing Nodes
1. Publisher登録
a. https://registry.comfy.org/ja
b. 開始する
c. Google or GitHubアカウントでログイン
d. + 新しいパブリッシャーからユーザー名・表示名を設定
ユーザー名は変更不可
2. APIキーの取得
a. 先程のページ(https://registry.comfy.org/ja/publishers/ユーザー名)へ
b. + 新しいキーを作成
c. 名前をつけて秘密鍵を作成
APIキーなので言わずもがなですが、一回しか表示されません
3. Comfy CLIのインストール
Comfy Registryを操作するための公式ライブラリです
$ pip install comfy-cli
4. プロジェクトの初期化
a. 作っているカスタムノードのルートに移動
b. 以下を実行
$ comfy node init
Do you agree to enable tracking to improve the application? [y/N]:
CLIの利用統計を匿名でComfy側に送信するか聞かれるので答える(yes or No)
c. pyproject.tomlが自動生成される
cf. https://docs.comfy.org/registry/specificationspyproject.toml
基本的には勝手に参照して入力してくれる
ただし、以下の部分は必須なので忘れずに先程🦊カスタムノードをComfy Registryに登録する#68f27589000000000039a4bd登録したユーザー名を書く
code:pyproject.toml
tool.comfy
PublisherId = "ユーザー名"
その他、descriptionやバージョンなどは任意で編集すると良いかも
5. Comfy Registryに公開 (Comfy CLI)
a. pyproject.tomlをpush？しておいたほうがいい？
b. 以下を実行
$ comfy node publish
これをやるとnode.zipが作成されるのだけど、邪魔なので.gitignoreに入れたほうがいいかもしれないnomadoor.icon
c. APIキーを求められるので先程🦊カスタムノードをComfy Registryに登録する#68f278cf000000000039a4c2で作ったAPIをコピペ → Enter
d. 成功していれば、以下のページを開くと登録したカスタムノードが表示されているハズ
$ https://registry.comfy.org/ja/publishers/ユーザー名
e.g. https://registry.comfy.org/ja/publishers/nomadoor/nodes/temporal-mask-tools
6. Comfy Registryに公開 (GitHub Actions)
Comfy CLIは手動で登録しないといけないので、pyproject.tomlのバージョン番号を上げてpushしたタイミングで勝手に更新されるようにします
a. 自分のカスタムノードのリポジトリに移動
b. ⚙settings → Secrets and variables → Actions → New repository secret
c. NameをREGISTRY_ACCESS_TOKENに、Secret(値)に先程🦊カスタムノードをComfy Registryに登録する#68f278cf000000000039a4c2のAPIキーを入力してAdd secret
d. 自分のリポジトリの以下の場所にymlファイルを追加
code:repo
comfyui_custom_node/
└─ .github/
└─ workflows/
└─ publish_action.yml ← このファイルを新規作成
e. 以下の内容をそのまま書き込んでcommit → push
code:publish_action.yml
name: Publish to Comfy registry
on:
workflow_dispatch:
push:
branches:
- main
paths:
- "pyproject.toml"
jobs:
publish-node:
name: Publish Custom Node to registry
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Publish Custom Node
uses: Comfy-Org/publish-node-action@main
with:
personal_access_token: ${{ secrets.REGISTRY_ACCESS_TOKEN }} ## Add your own personal access token to your Github Repository secrets and reference it here.
f. テスト
pyproject.tomlのバージョンを1.0.1に変更してcommit →　push
Comfy Registryの画面でバージョンが変わっていればOK(ちょっと時間かかるかも)